home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsIAsyncInputStream.idl < prev    next >
Text File  |  2006-05-08  |  6KB  |  137 lines
  1. /* ***** BEGIN LICENSE BLOCK *****
  2.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  3.  *
  4.  * The contents of this file are subject to the Mozilla Public License Version
  5.  * 1.1 (the "License"); you may not use this file except in compliance with
  6.  * the License. You may obtain a copy of the License at
  7.  * http://www.mozilla.org/MPL/
  8.  *
  9.  * Software distributed under the License is distributed on an "AS IS" basis,
  10.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11.  * for the specific language governing rights and limitations under the
  12.  * License.
  13.  *
  14.  * The Original Code is Mozilla.
  15.  *
  16.  * The Initial Developer of the Original Code is
  17.  * Netscape Communications Corporation.
  18.  * Portions created by the Initial Developer are Copyright (C) 2002
  19.  * the Initial Developer. All Rights Reserved.
  20.  *
  21.  * Contributor(s):
  22.  *   Darin Fisher <darin@netscape.com>
  23.  *
  24.  * Alternatively, the contents of this file may be used under the terms of
  25.  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27.  * in which case the provisions of the GPL or the LGPL are applicable instead
  28.  * of those above. If you wish to allow use of your version of this file only
  29.  * under the terms of either the GPL or the LGPL, and not to allow others to
  30.  * use your version of this file under the terms of the MPL, indicate your
  31.  * decision by deleting the provisions above and replace them with the notice
  32.  * and other provisions required by the GPL or the LGPL. If you do not delete
  33.  * the provisions above, a recipient may use your version of this file under
  34.  * the terms of any one of the MPL, the GPL or the LGPL.
  35.  *
  36.  * ***** END LICENSE BLOCK ***** */
  37.  
  38. #include "nsIInputStream.idl"
  39.  
  40. interface nsIInputStreamCallback;
  41. interface nsIEventTarget;
  42.  
  43. /**
  44.  * If an input stream is non-blocking, it may return NS_BASE_STREAM_WOULD_BLOCK
  45.  * when read.  The caller must then wait for the stream to have some data to 
  46.  * read.  If the stream implements nsIAsyncInputStream, then the caller can use 
  47.  * this interface to request an asynchronous notification when the stream
  48.  * becomes readable or closed (via the AsyncWait method).
  49.  *
  50.  * While this interface is almost exclusively used with non-blocking streams, it
  51.  * is not necessary that nsIInputStream::isNonBlocking return true.  Nor is it
  52.  * necessary that a non-blocking nsIInputStream implementation also implement
  53.  * nsIAsyncInputStream.
  54.  */
  55. [scriptable, uuid(15a15329-00de-44e8-ab06-0d0b0d43dc5b)]
  56. interface nsIAsyncInputStream : nsIInputStream
  57. {
  58.     /**
  59.      * This method closes the stream and sets its internal status.  If the 
  60.      * stream is already closed, then this method is ignored.  Once the stream
  61.      * is closed, the stream's status cannot be changed.  Any successful status
  62.      * code passed to this method is treated as NS_BASE_STREAM_CLOSED, which
  63.      * has an effect equivalent to nsIInputStream::close. 
  64.      *
  65.      * NOTE: this method exists in part to support pipes, which have both an 
  66.      * input end and an output end.  If the input end of a pipe is closed, then
  67.      * writes to the output end of the pipe will fail.  The error code returned 
  68.      * when an attempt is made to write to a "broken" pipe corresponds to the
  69.      * status code passed in when the input end of the pipe was closed, which
  70.      * greatly simplifies working with pipes in some cases.
  71.      *
  72.      * @param aStatus
  73.      *        The error that will be reported if this stream is accessed after
  74.      *        it has been closed.
  75.      */
  76.     void closeWithStatus(in nsresult aStatus);
  77.  
  78.     /**
  79.      * Asynchronously wait for the stream to be readable or closed.  The
  80.      * notification is one-shot, meaning that each asyncWait call will result
  81.      * in exactly one notification callback.  After the OnInputStreamReady event
  82.      * is dispatched, the stream releases its reference to the 
  83.      * nsIInputStreamCallback object.  It is safe to call asyncWait again from the
  84.      * notification handler.
  85.      *
  86.      * This method may be called at any time (even if read has not been called).
  87.      * In other words, this method may be called when the stream already has
  88.      * data to read.  It may also be called when the stream is closed.  If the
  89.      * stream is already readable or closed when AsyncWait is called, then the
  90.      * OnInputStreamReady event will be dispatched immediately.  Otherwise, the
  91.      * event will be dispatched when the stream becomes readable or closed.
  92.      * 
  93.      * @param aCallback
  94.      *        This object is notified when the stream becomes ready.
  95.      * @param aFlags
  96.      *        This parameter specifies optional flags passed in to configure
  97.      *        the behavior of this method.  Pass zero to specify no flags.
  98.      * @param aRequestedCount
  99.      *        Wait until at least this many bytes can be read.  This is only
  100.      *        a suggestion to the underlying stream; it may be ignored.  The
  101.      *        caller may pass zero to indicate no preference.
  102.      * @param aEventTarget
  103.      *        Specify NULL to receive notification on ANY thread (possibly even
  104.      *        recursively on the calling thread -- i.e., synchronously), or
  105.      *        specify that the notification be delivered to a specific event
  106.      *        target.
  107.      */
  108.     void asyncWait(in nsIInputStreamCallback aCallback,
  109.                    in unsigned long aFlags,
  110.                    in unsigned long aRequestedCount,
  111.                    in nsIEventTarget aEventTarget);
  112.  
  113.     /**
  114.      * If passed to asyncWait, this flag overrides the default behavior,
  115.      * causing the OnInputStreamReady notification to be suppressed until the
  116.      * stream becomes closed (either as a result of closeWithStatus/close being
  117.      * called on the stream or possibly due to some error in the underlying
  118.      * stream).
  119.      */
  120.     const unsigned long WAIT_CLOSURE_ONLY = (1<<0);
  121. };
  122.  
  123. /**
  124.  * This is a companion interface for nsIAsyncInputStream::asyncWait.
  125.  */
  126. [scriptable, uuid(d1f28e94-3a6e-4050-a5f5-2e81b1fc2a43)]
  127. interface nsIInputStreamCallback : nsISupports
  128. {
  129.     /**
  130.      * Called to indicate that the stream is either readable or closed.
  131.      *
  132.      * @param aStream
  133.      *        The stream whose asyncWait method was called.
  134.      */
  135.     void onInputStreamReady(in nsIAsyncInputStream aStream);
  136. };
  137.